Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(localenv): add details for tenant credentials for admin ui #3251

Merged
merged 5 commits into from
Feb 11, 2025

Conversation

BlairCurrey
Copy link
Contributor

@BlairCurrey BlairCurrey commented Jan 28, 2025

Changes proposed in this pull request

  • adds details and instructions for using the frontend with the tenant credentials

Context

fixes: #3250

Checklist

  • Related issues linked using fixes #number
  • Tests added/updated
  • Make sure that all checks pass
  • Bruno collection updated (if necessary)
  • Documentation issue created with user-docs label (if necessary)
  • OpenAPI specs updated (if necessary)

@github-actions github-actions bot added the type: localenv Local playground label Jan 28, 2025

The Admin UI requires a valid API secret and tenant id to make requests to the Admin APIs, which must be submitted via a form on the frontend. For our convenience, we log a link on MASE start that can be used to access the Admin UI and set the credentials automatically. The credentials used pull from the MASE's `SIGNATURE_SECRET` and `OPERATOR_TENANT_ID` environment variables.

We have secured access to Rafiki Admin using [Ory Kratos](https://www.ory.sh/docs/kratos/ory-kratos-intro); however, in our local playground setup we've chosen to disable authorization for easier development and testing interactions.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not something to change per se, but I do wonder what purpose ORY Kratos serves anymore since tenant id/secret is itself a form of identity management

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does seem superfluous.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually removing Kratos might be something to bring up with the team later, as well.

In order to manage and view information about the Rafiki instance(s) you can use the [Rafiki Admin](https://rafiki.dev/admin/admin-user-guide) UI. We have secured access to Rafiki Admin using [Ory Kratos](https://www.ory.sh/docs/kratos/ory-kratos-intro); however, in our local playground setup we've chosen to disable authorization for easier development and testing interactions.
In order to manage and view information about the Rafiki instance(s) you can use the [Rafiki Admin](https://rafiki.dev/admin/admin-user-guide) UI.

The Admin UI requires a valid API secret and tenant id to make requests to the Admin APIs, which must be submitted via a form on the frontend. For our convenience, we log a link on MASE start that can be used to access the Admin UI and set the credentials automatically. The credentials used pull from the MASE's `SIGNATURE_SECRET` and `OPERATOR_TENANT_ID` environment variables.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A code snippet of the log that outputs the link might be good as an example of what to look for.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added

@BlairCurrey BlairCurrey requested a review from brad-dow February 10, 2025 18:03
@BlairCurrey
Copy link
Contributor Author

@brad-dow Added you because you made some edits here recently which moved a fair amount of the content out to rafiki.dev. I included this new requirement in the readme because it is pretty core info - it's a new basic requirement for using the admin UI so I wanted it front-and-center.

@BlairCurrey BlairCurrey requested a review from njlie February 10, 2025 18:05
@BlairCurrey BlairCurrey merged commit 4a4a48d into 2893/multi-tenancy-v1 Feb 11, 2025
37 checks passed
@BlairCurrey BlairCurrey deleted the bc/3250/document-new-frontend-req branch February 11, 2025 16:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: localenv Local playground
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants